MarkLogic 12 Product Documentation
GET /manage/v2/databases/{id|name}?view=describe-indexes

Summary

This resource address returns the list of range index specification for the database, identified either by id or name.

URL Parameters
format The format of the returned data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If the URI is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The range index types include Range element, Range element attribute, Range field, Range path, Geospatial path, Geospatial element, Geospatial element child, Geospatial element pair, Geospatial element attribute pair, URI lexicon (system default), Collection lexicon (system default). Each index specification starts with index-id, which can be mapped with the memory-detail output from /manage/v2/forests/{id|name}?view=status&property=memory-detail to check individual index memory consumption.

Example


http://localhost:8002/manage/v2/databases/Meters?view=describe-indexes
==> 
<database-describe-indexes xmlns="http://marklogic.com/manage/databases" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://marklogic.com/manage/databases manage-databases.xsd">
  <id>18408072765933642562</id>
  <name>Meters</name>
  <meta>
    <uri>/manage/v2/databases/Meters?view=describe-indexes</uri>
    <current-time>2023-07-25T15:19:22.552636-07:00</current-time>
    <elapsed-time units="sec">0.161478</elapsed-time>
  </meta>
  <range-element-indexes>
    <range-element-index>
      <index-id>14095857849303712152</index-id>
      <scalar-type>unsignedLong</scalar-type>
      <namespace-uri>http://marklogic.com/manage/meters</namespace-uri>
      <localname>cluster-id</localname>
      <range-value-positions>true</range-value-positions>
      <invalid-values>reject</invalid-values>
    </range-element-index>
    <range-element-index>
      <index-id>12488401956028797537</index-id>
      <scalar-type>unsignedLong</scalar-type>
      <namespace-uri>http://marklogic.com/manage/meters</namespace-uri>
      <localname>group-id</localname>
      <range-value-positions>true</range-value-positions>
      <invalid-values>reject</invalid-values>
    </range-element-index>
    ....
  </range-element-indexes>
  <range-element-attribute-indexes>
    <range-element-attribute-index>
      <index-id>16306666406086987588</index-id>
      <scalar-type>unsignedLong</scalar-type>
      <parent-namespace-uri>http://marklogic.com/manage/meters/label</parent-namespace-uri>
      <parent-localname>label</parent-localname>
      <localname>id</localname>
      <range-value-positions>false</range-value-positions>
      <invalid-values>reject</invalid-values>
    </range-element-attribute-index>
    ...
  </range-element-attribute-indexes>
  ...
  <uri-lexicon>
  <index-id>7203445872012074451</index-id>
  </uri-lexicon>
  <collection-lexicon>
  <index-id>16041923477648893628</index-id>
  </collection-lexicon>
</database-describe-indexes>
Powered by MarkLogic Server | Terms of Use | Privacy Policy